Skip to content

Conversation

@guydavenport
Copy link
Contributor

No description provided.

@guydavenport guydavenport linked an issue Dec 24, 2025 that may be closed by this pull request
"string"
]
],
"example": "71 Pilgrim Avenue Chevy Chase MD 20815"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer this not be a real place. It shouldn't really matter but it seems weird to publish a real address publicly without knowing exactly what is there. Also, BrAPI is international so it should include the country code.
I would suggest "123 First Street, Townsville, AB 12345, USA"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was in the original yaml, I will change it in both places

},
"type": "array",
"example": [
"examples": [
Copy link
Member

@BrapiCoordinatorSelby BrapiCoordinatorSelby Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change needs to be double checked. These are all Array type objects, so a singular example would be an array of values. changing the key to examples is incorrect, unless there is a good technical reason

Copy link
Contributor Author

@guydavenport guydavenport Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was following the Java representation of JSON schema, which has both example and examples. example take an object and examples a list of objects. https://json-schema.org/understanding-json-schema/reference/annotations. I think the singular ‘example’ is just a helper function for the case when the list has a single element. In OpenAPI you can use either https://swagger.io/docs/specification/v3_0/adding-examples/, but example is singular and examples is a list.

Copy link
Member

@BrapiCoordinatorSelby BrapiCoordinatorSelby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments. I think co-pilot messed up the Request objects

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Examples are missing in JSON schema

3 participants